home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / page301.zip / PAGEME.DOC < prev    next >
Text File  |  1992-12-21  |  9KB  |  172 lines
  1.                                 DOCUMENTATION
  2. ╔═════════════════════════════════════════════════════════════════════════════╗
  3. ║                               ** PAGEME ***                                 ║
  4. ║                 Copyright (c) 1991-1993 by Travis A. Wise                   ║
  5. ║            Written in QuickBasic for the HamBBS (408) 267-6396              ║
  6. ║                                                                             ║
  7. ║                               version 3.01                                  ║
  8. ║         Travis A. Wise; 1421 Grace Avenue; San Jose, CA 95125-5206          ║
  9. ╚═════════════════════════════════════════════════════════════════════════════╝
  10.  
  11. 1. INTRODUCTION
  12.  
  13.         I don't like reading documentation, so this is going to be as brief as
  14.         I can make it.
  15.  
  16.         PLEASE NOTE: Your [computer <-> modem] baud rate MUST be 19200 BPS
  17.         for this program to operate.
  18.  
  19.         If all you want to do is use PAGEME from a batch file, please skip
  20.         to part 5.
  21.  
  22.         PAGEME is a program which allows a BBS SysOp to monitor their board's
  23.         activity via their pocket pager.  Their pager will go off, displaying a
  24.         a number of their choice (such as the BBS phone number), followed by an
  25.         individual user code (set by SysOp) which will alert the SysOp to the
  26.         fact that a certain user has just logged off.  Currently, there is a
  27.         capacity for up to 100 "watched" users to be monitored by this program.
  28.  
  29.         This program was designed for Wildcat!, and has been tested with
  30.         Wildcat! 3.55s, but I suspect it can be adapted for other BBSs.
  31.  
  32.         The only requirement for BBS use is that the BBS be able to execute
  33.         a program (batch or executable) after each call, and that the DOOR.SYS
  34.         (or comparable) file have the COM port in line #1, and the users name
  35.         in line #10.
  36.  
  37.         This program was written in QuickBasic by a 17 year old high school
  38.         student named Travis A. Wise.  If you like the program, please send
  39.         $5 to: Travis A. Wise, 1421 Grace Avenue, San Jose, CA 95125-5206.
  40.         There are no strings attached to this program; it is fully functional.
  41.       
  42. 2. FILES INCLUDED
  43.  
  44.         PAGEME.EXE  -  The program
  45.         PAGEME.DOC  -  This documentation
  46.         PAGEME.CFG  -  Sample configuration file
  47.  
  48. 3. SETUP
  49.  
  50.        Because this program needs to be executed after each caller, you will
  51.        need to tell your BBS to execute PAGEME.EXE after each call.  Wildcat!
  52.        users should create create a POSTCALL.RUN file in your
  53.        ..\WC30\WCWORK\NODE# directory.  POSTCALL.RUN should contain the full
  54.        path/name to PAGEME.EXE.
  55.  
  56.        Create a subdirectory called "PAGEME" in whatever drive your BBS runs
  57.        from.  Move PAGEME.CFG there.  The PAGEME subdirectory MUST be a
  58.        "first level" directory (i.e. "C:\PAGEME\"), and needs to contain only
  59.        PAGEME.CFG.
  60.  
  61. 4. CONFIGURATION
  62.  
  63.    LINE 1:  The first character must be one of the following:
  64.                "0" = Start PAGEME in 'off' (disabled) mode
  65.                "1" = Start PAGEME in 'on' (enabled) mode
  66.    LINE 2:  Full path/name to DOOR.SYS (or comaprable) file.  This file is
  67.             created when Wildcat! opens a door and terminates a call.
  68.             ex.: "D:\WC30\WCWORK\NODE1\DOOR.SYS"
  69.    LINE 3:  The first character must be one of the following:
  70.                "Y" = Call beeper every time SysOp logs off, local or remote
  71.                "N" = Do not call beeper when SysOp logs off
  72.             Next, put the COM port number of your modem, followed by your
  73.             beeper's phone number (no "-" in the number).  In the next
  74.             field, put whatever number you wish displayed on your pager
  75.             immediately preceeding the individual user code (I suggest
  76.             your BBS's phone number for easy recognition).
  77.             NOTE: All of this information on LINE 2 needs to be on one line,
  78.             with each field seperated by a comma (see sample below).
  79.    LINE 4:  In all caps, put your name (SysOp of the BBS), followed by
  80.             his/her/your individual user code (make one up).  This is
  81.             REQUIRED even if you selected not to have your beeper go off
  82.             when the SysOp logs off.
  83.    LINES 5-105:
  84.             In these lines, in all CAPS, put the "watched users" names
  85.             and individual user codes (again, make some up).  On the
  86.             line immediately AFTER the last record, put a ".".
  87.  
  88.         SAMPLE #1:                          SAMPLE #2:
  89.  
  90.         0                                   1
  91.         D:\WC30\WCWORK\NODE1\DOOR.SYS       C:\WC30\WCWORK\NODE1\DOOR.SYS
  92.         N,2,3450436,2676396                 Y,1,2551234,6396
  93.         SYSOPS NAME,80                      TRAVIS WISE,1000
  94.         USER ONE,91                         JOE SMITH,10
  95.         USER TWO,92                         JOHN SMITH,20
  96.         USER THREE,93                       BOB ROBERTS,25
  97.         .                                   JOHN DOE,30
  98.                                             DALE EVANS,40
  99.                                             .
  100.  
  101. 5. EXECUTION FROM A BATCH FILE
  102.  
  103.         PAGEME can be used to monitor batch file execution.  By placing
  104.         the command line "PAGEME #" where "#" is any number greater than
  105.         "0", when the batch file is executed, the beeper will display
  106.         a phone number followed by a "-#" where "#" is the number in the
  107.         command line.
  108.  
  109.         Configuration for this is similar to part 3 and 4.  If you have
  110.         already set up PAGEME through parts 3 and 4, disregard the
  111.         following.
  112.  
  113.         Create a subdirectory called "PAGEME" in whatever drive your batch
  114.         file will run from.  Move PAGEME.CFG there.  The PAGEME subdirectory
  115.         MUST be a "first level" directory (i.e. "C:\PAGEME\"), and needs to
  116.         contain only PAGEME.CFG.
  117.  
  118.         Text edit PAGEME.CFG in the following fashion:
  119.            1. On the first line, put a "1".  Leave the second line blank (if
  120.               this gives you a problem, put the full path/name to PAGEME.CFG
  121.               i.e. C:\PAGEME\PAGEME.CFG).
  122.            2. Second line should read as follows:
  123.                 Y,[MODEM PORT #],[PAGER #],[DISPLAY #]
  124.               Leave the "Y" alone - it must be there.  The [MODEM PORT #]
  125.               is your one digit COM port number for your modem (must be
  126.               between 1 and 4), the [PAGER #] is the phone number that
  127.               PAGEME will dial, and [DISPLAY #] is the number that will
  128.               be displayed on your beeper, immediately before the command
  129.               line number (example: "2676396-10" if you entered "PAGEME 10"
  130.               at the command prompt).  The rest of the configuration file
  131.               should be empty.
  132.  
  133. 6. TURNING IT ON/OFF
  134.  
  135.         To turn PAGEME off (disable it), type "PAGEME OFF".  To turn it back
  136.         on again, type "PAGEME ON".  This is useful to temporarily disable
  137.         the paging features (at night via an event, etc.).
  138.  
  139.         I recommend that Wildcat! SysOps create two "idle screen programs."
  140.         One with "pageme on" to turn the program on, and one with "pageme off"
  141.         to turn it off.  This is as close to a toggle switch as I can get.
  142.  
  143. 6. TECH SUPPORT/DISTRIBUTION
  144.  
  145.         Call the HamBBS (408) 267-6396 for tech support, and for the latest
  146.         version.  I like improving and making changes to things, so new
  147.         versions should be released about once a month.  Please distribute
  148.         PAGEME freely...just be sure and include the documentation and sample
  149.         config file, and of course, it is illegal for you to modify the
  150.         program its self, so don't even think about it.
  151.  
  152. 7. PAGEME VERSION HISTORY
  153.    1.xx          Not released to public
  154.    2.00          Not released to public
  155.    2.01          First version released to public (BATCH FILE)
  156.    2.02          Documentation added
  157.    2.03          Timing routines added
  158.    3.00 12/20/92 QuickBasic public version; [44016 bytes]
  159.    3.01 12/21/92 Increased number of "watched users" from 5 to 100
  160.                  Added ability to use PAGEME from batch files to allow display
  161.                       of codes to monitor batch execution
  162.                  Error handling
  163.                  Added ability to toggle on/off
  164.                  [46104 bytes]
  165.  
  166. 8. FUTURE IMPROVEMENTS:
  167.         * Optional page sysop when the sysop has been paged by ANY user
  168.         * User definable modem <-> computer speed
  169.         * User definable location of pageme.cfg file
  170.         * User definable pause lengths per individual user's modems
  171.         * More flexability in paging when SysOp has been on (local vs modem)
  172.